/*
 * $Header: /cvs/xzsp-mysql/src/org/apache/struts/validator/DynaValidatorForm.java,v 1.1.1.1 2006/09/26 01:18:29 tenghl Exp $
 * $Revision: 1.1.1.1 $
 * $Date: 2006/09/26 01:18:29 $
 *
 * ====================================================================
 *
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 1999-2003 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution, if
 *    any, must include the following acknowlegement:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowlegement may appear in the software itself,
 *    if and wherever such third-party acknowlegements normally appear.
 *
 * 4. The names "The Jakarta Project", "Struts", and "Apache Software
 *    Foundation" must not be used to endorse or promote products derived
 *    from this software without prior written permission. For written
 *    permission, please contact apache@apache.org.
 *
 * 5. Products derived from this software may not be called "Apache"
 *    nor may "Apache" appear in their names without prior written
 *    permission of the Apache Group.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 */

package org.apache.struts.validator;

import java.io.Serializable;
import java.util.Map;
import javax.servlet.ServletContext;
import javax.servlet.http.HttpServletRequest;
import org.apache.commons.beanutils.DynaBean;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.commons.validator.Validator;
import org.apache.commons.validator.ValidatorException;
import org.apache.commons.validator.ValidatorResults;
import org.apache.struts.action.ActionErrors;
import org.apache.struts.action.DynaActionForm;
import org.apache.struts.action.ActionMapping;

/**
 * <p>This class extends <strong>DynaActionForm</strong> and provides
 * basic field validation based on an XML file.  The key passed into the
 * validator is the action element's 'name' attribute from the
 * struts-config.xml which should match the form element's name attribute
 * in the validation.xml.</p>
 *
 * <ul><li>See <code>ValidatorPlugin</code> definition in struts-config.xml
 * for validation rules.</li></ul>
 *
 * @author David Winterfeldt
 * @version $Revision: 1.1.1.1 $ $Date: 2006/09/26 01:18:29 $
 * @since Struts 1.1
 * @see org.apache.struts.action.ActionForm
 */
public class DynaValidatorForm extends DynaActionForm implements DynaBean, Serializable {

    /**
     * Commons Logging instance.
     */
    private static Log log = LogFactory.getLog(DynaValidatorForm.class);

   /**
     * The results returned from the validation performed
     * by the <code>Validator</code>.
     */
    protected ValidatorResults validatorResults = null;

   /**
     * Used to indicate the current page of a multi-page form.
     */
    protected int page = 0;

   /**
     * Gets page.
    * @return page number.
     */
    public int getPage() {
        return page;
    }

   /**
     * Sets page.
    * @param page page number
     */
    public void setPage(int page) {
        this.page = page;
    }

    /**
      * Validate the properties that have been set from this HTTP request,
      * and return an <code>ActionErrors</code> object that encapsulates any
      * validation errors that have been found.  If no errors are found, return
      * <code>null</code> or an <code>ActionErrors</code> object with no
      * recorded error messages.
      *
      * @param mapping The mapping used to select this instance.
      * @param request The servlet request we are processing.
      * @return <code>ActionErrors</code> object that encapsulates any validation errors.
      */
    public ActionErrors validate(ActionMapping mapping, HttpServletRequest request) {
        // set the page variable before validating
        Map props = this.getMap();
        if (props.containsKey("page")) {
            this.page = ((Integer) props.get("page")).intValue();
        }

        ServletContext application = getServlet().getServletContext();
        ActionErrors errors = new ActionErrors();

        Validator validator =
            Resources.initValidator(mapping.getAttribute(), this, application, request, errors, page);

        try {
            validatorResults = validator.validate();
        } catch (ValidatorException e) {
            log.error(e.getMessage(), e);
        }

        return errors;
    }

   /**
     * Convenience method that call the comparable servlet log method and writes
     * an explanatory message and a stack trace for a given Throwable exception to the
     * servlet log file.
     *
     * @param   message     String that describes the error or exception
     * @deprecated Use common-logging, or other logging implementation to log debug messages.
     */
    protected void log(String message) {
        if (getServlet().getDebug() >= 1) {
            getServlet().log(message);
        }
    }

   /**
     * Convenience method that call the comparable servlet log method and writes
     * an explanatory message and a stack trace for a given Throwable exception to the
     * servlet log file.
     *
     * @param   message     String that describes the error or exception
     * @param   throwable   Throwable error or exception
     * @deprecated Use common-logging, or other logging implementation to log debug messages.
     */
    protected void log(String message, Throwable throwable) {
        if (getServlet().getDebug() >= 1) {
            getServlet().log(message, throwable);
        }
    }

   /**
     * Reset all properties to their default values.
     *
     * @param mapping The mapping used to select this instance
     * @param request The servlet request we are processing
     */
    public void reset(ActionMapping mapping, HttpServletRequest request) {
        super.reset(mapping, request);
        page = 0;
        validatorResults = null;
    }

   /**
     * Get results of the validation performed by the
     * <code>Validator</code>.
    * @return validator results as ValidatorResults object
     */
    public ValidatorResults getValidatorResults() {
        return validatorResults;
    }

   /**
     * Set results of the validation performed by the
     * <code>Validator</code>.
    * @param validatorResults  Set results of the validation performed
     */
    public void setValidatorResults(ValidatorResults validatorResults) {
        this.validatorResults = validatorResults;
    }

   /**
     * Returns a <code>Map</code> of values returned
     * from any validation that returns a value other than
     * <code>null</code> or <code>Boolean</code> with the
     * key the full property path of the field.
    * @return Returns a <code>Map</code> of values, otherwise returns null if no results.
     */
    public Map getResultValueMap() {
        return (validatorResults != null ? validatorResults.getResultValueMap() : null);
    }

}

